Get recording
GET
/recordings/{recordingId}
Get a recording's metadata and links to its events, player, and screenshot. When authenticating with a private API key, set includeEvents=true to include the recording events. Presigned URLs for this endpoint return metadata and links only; use the signed events link to fetch events.
Authorizations
Private API Key
Bearer token for authentication. Use your private API key as the token.
Parameters
Path Parameters
recordingId*
The recording ID
Type
Requiredstring
Example
"000e8400-e00b-00d0-a716-446655440000"Format
"uuid"Query Parameters
includeSignedUrls
Include presigned recording links in the detail response.
Type
boolean
Example
trueincludeEvents
Include the recording event stream in the detail response.
Type
boolean
Example
trueResponses
Successfully retrieved recording details
application/json
JSON "recordingId": "550e8400-e29b-41d4-a716-446655440000", "links": { "self": "/recordings/550e8400-e29b-41d4-a716-446655440000", "events": "/recordings/550e8400-e29b-41d4-a716-446655440000/events", "player": "/recordings/550e8400-e29b-41d4-a716-446655440000/player", "screenshot": "/recordings/550e8400-e29b-41d4-a716-446655440000/screenshot", "eventsSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/events?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6...", "playerSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/player.html?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6...", "screenshotPngSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/screenshot.png?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6..." }, "metadata": { "additionalProperties": "string" }
{
}